/*
 *   Copyright (c) 2011 Hitachi Data Systems, Inc.
 *
 *   Permission is hereby granted to  this software and associated
 *   documentation files (the "Software"), subject to the terms and
 *   conditions of the Sample Source Code License (SSCL) delivered
 *   with this Software. If you do not agree to the terms and
 *   conditions of the SSCL,
 *
 *     (i)  you must close this file and delete all copies of the
 *          Software, and
 *     (ii) any permission to use the Software is expressly denied.
 *
 */

package com.hds.hcp.apihelpers.query.result;

/**
 * This class represents the <code>status</code> part of the <code>queryResult</code>
 * that is returned by an HCP query request. 
 * <p> 
 * The class is constructed as a Bean to facilitate utilizing Jackson JSON 
 * serializer to create JSON formatted requests. The Jackson JSON component
 * will interpret the Bean format and populate this object when parsing the
 * stream.
 * 
 * @version 4.1
 */
public class Status {
	public enum Code { COMPLETE, INCOMPLETE };
	
	private String _message;
	private Code _code;
	private Integer _totalResults;
	private Integer _results;
	
	public void setMessage(String inMessage) { _message = inMessage; };
	public void setCode(Code inCode) { _code = inCode; };
	public void setTotalResults(Integer inTotalResults) { _totalResults = inTotalResults; };
	public void setResults(Integer inResults) { _results = inResults; };
	
	public String getMessage() { return _message; };
	public Code getCode() { return _code; };
	public Integer getTotalResults() { return _totalResults; };
	public Integer getResults() { return _results; };
	
}
